From IQsimWiki
XIQS Get Device List - GSM Device Management
| Description
|
getXIQSDeviceList ( [ Long id_partition ] [, filter f ] )
Get a list of GSM Devices owned by this partition. If the current logged user is administrator, he gets the full list of all available devices unless a 'id_partition' parameter is specified.
|
| Parameters
|
|
[ Long id_partition ]
Partition Id
[ filter f ]
|
| Return Values
|
List List of GSM device objects
Long id - Device Id
String name - Name of the GSM device
String regname - Registration name
String ip - GSM Device IP address
Long id_master - If the GSM device is a iQSIM gateway configured in relay mode, this parameter is ID of the iQSIM gateway master
Integer portnb - Number of physical GSM ports of the GSM device
String dns - GSM device host name
Integer status - Link status between the iQSIM Server and the GSM device
Possible values for status are:
0 - Device stopped
1 - Device connected
2 - Device connecting
3 - Device not validated
12 - Authentication failed(Device stopped)
13 - Database Error(Device stopped)
14 - Missing license(Device stopped)
Integer mode - Master device connection mode (0 = passive / 1 = active)
Long id_partition - Partition Id
String username - Login name for the connection
The default login name is 'administrator'
String userpass - Password for the connection
The default password is 'iQSIM'
Integer country - MCC of the country where the given iQSIM Gateway is located
String serial - Serial number of the given iQSIM Gateway
Long id_manager - SIM Manager Id
String managername - SIM Manager name
Integer cardusednb - Number of used cards
Long callduration - Total call duration
Long concallnb - Number of connected calls
Long misscallnb - Number of failed calls
String mastername - Master device name
Long simcount - Number of SIM cards
String areacode - This device area location
Integer sendsms - SMS capacity
Integer failstatus - On failure, the error number
Integer asr - Average Ratio (in %)
Integer acd - Average Call Duration (in ms)
Long keepalivedelay -
Integer portavailnb - Number of port usable
String version - Internal revision when available
String iplocal - Local IP address
String ftpdns - FTP dns address
Integer ftpport - FTP port
String ftplogin - FTP user login
String ftppassw - FTP user password
String portgroups - List of port groups where this GSM device belongs
String devicegroups - List of device groups where this GSM device belongs
Integer useddata - Sum of data usage of all GSM ports of the given GSM device
Integer flags - Device flags, valid only for MiFi devices.
Supported values:
0x01 - Enable additional debug traces.
0x02 - Automatic daypass activation.
Long daypass
Long pass_duration
Long pass_maxdata
Long pass_maxlowspeeddata
Long pass_number
Long pass_extranumber
Long pass_timezone
String pass_language
Long pass_sliding
String pass_businessinfo
Long pass_status
Long pass_remainingdata
Long pass_remaininglowspeeddata
Long pass_enddate
String app_version - Device application version
Error Data structure ( Error Management )
Possible failure code returns
*ERR_SRV_INTERNAL (500) ERR_MSG_NO_DB
|
| Example
|
|
[REQUEST]
<?xml version="1.0" encoding="UTF-8"?>
<command tid="03a42232-a7b7-41d6-9c91-7e05fa943b77" name="getXIQSDeviceList">
<param type="long">2</param>
<simplefilter>
<start>0</start>
<limit>250</limit>
<DIR>DESC</DIR>
<SORT>id</SORT>
</simplefilter>
</command>
[ANSWER (OK)]
<?xml version="1.0" encoding="UTF-8"?>
<event type="return" tid="03a42232-a7b7-41d6-9c91-7e05fa943b77">
<meta-data>
<meta-value>
<name>start</name>
<pos>1</pos>
</meta-value>
<meta-value>
<name>count</name>
<pos>2</pos>
</meta-value>
<meta-value>
<name>total</name>
<pos>3</pos>
</meta-value>
<dvc-meta>
<meta-value>
<name>id</name>
<pos>1</pos>
</meta-value>
<meta-value>
<name>name</name>
<pos>2</pos>
</meta-value>
<meta-value>
<name>regname</name>
<pos>3</pos>
</meta-value>
<meta-value>
<name>ip</name>
<pos>4</pos>
</meta-value>
<meta-value>
<name>id_master</name>
<pos>5</pos>
</meta-value>
<meta-value>
<name>portnb</name>
<pos>6</pos>
</meta-value>
<meta-value>
<name>dns</name>
<pos>7</pos>
</meta-value>
<meta-value>
<name>status</name>
<pos>8</pos>
</meta-value>
<meta-value>
<name>mode</name>
<pos>9</pos>
</meta-value>
<meta-value>
<name>id_partition</name>
<pos>10</pos>
</meta-value>
<meta-value>
<name>username</name>
<pos>11</pos>
</meta-value>
<meta-value>
<name>userpass</name>
<pos>12</pos>
</meta-value>
<meta-value>
<name>country</name>
<pos>13</pos>
</meta-value>
<meta-value>
<name>serial</name>
<pos>14</pos>
</meta-value>
<meta-value>
<name>id_manager</name>
<pos>15</pos>
</meta-value>
<meta-value>
<name>managername</name>
<pos>16</pos>
</meta-value>
<meta-value>
<name>cardusednb</name>
<pos>17</pos>
</meta-value>
<meta-value>
<name>callduration</name>
<pos>18</pos>
</meta-value>
<meta-value>
<name>concallnb</name>
<pos>19</pos>
</meta-value>
<meta-value>
<name>misscallnb</name>
<pos>20</pos>
</meta-value>
<meta-value>
<name>mastername</name>
<pos>21</pos>
</meta-value>
<meta-value>
<name>simcount</name>
<pos>22</pos>
</meta-value>
</dvc-meta>
</meta-data>
<param type="long">0</param>
<param type="long">250</param>
<param type="long">1</param>
<device>
<param type="long">2</param>
<param type="string">TestGW</param>
<param type="string"></param>
<param type="string">192.168.1.11</param>
<param type="long">2</param>
<param type="integer">16</param>
<param type="string">192.168.1.31</param>
<param type="integer">0</param>
<param type="integer">0</param>
<param type="long">2</param>
<param type="string">name</param>
<param type="string">pass</param>
<param type="integer">276</param>
<param type="string"></param>
<param type="long">0</param>
<param type="string"></param>
<param type="integer">0</param>
<param type="long">0</param>
<param type="long">0</param>
<param type="long">0</param>
<param type="string">TestGW</param>
<param type="long">0</param>
</device>
</event>
[ANSWER (Error)]
<?xml version="1.0" encoding="UTF-8"?>
<event type="error">
<meta-data>
<meta-value>
<name>err_code</name>
<pos>1</pos>
</meta-value>
<meta-value>
<name>err_desc</name>
<pos>2</pos>
</meta-value>
</meta-data>
<param type="integer">500</param>
<param type="string"> err.db.connection.failed</param>
</event>
|
